home *** CD-ROM | disk | FTP | other *** search
/ Express Pd: GALORE / Express Pd Galore - The Amiga PD & Shareware CD (1994)(Express Pd)[!][Amiga-CD32-CDTV].iso / productivity / printing / aroff / aroffenglish.doc (.png) < prev    next >
ANSI Art File  |  1994-02-10  |  21KB  |  640x8400
Labels: text | screenshot | black and white | document
OCR: is ABSOLUTLY FORBIDDEN. Im spite of several tests, mo warranty is made that there's no errors in ARoff. YOU USE THIS PROGRAM AT YOUR OWN RISKS. In no event will I be liable for any damage, direct or indirect, resulting of the use of ARoff. Introduction ARoff is a complete and powerful program for text formatting, with registers, macros, etc .: it takes as imput a source file including both text und formatting commands, to produce a formatted output file as you required. You cam look upom ARoff as a portage of "mroff" utility you find usually under UNIX system. However, both programs are fairly different, and there is surely a lot of things ARoff doesn't know. aroff [-wstack] [-1] <filemane> here <filemane> is the mane of file to process. If you specify (filemane>, ARoff will use the standard Input. For CAUTION: The ARoff current version doesn't work properly if you It as a pipe output (e.g. "cat toto I aroff -"). use The -w option allows you to increase the size of the intermal stack used by ARoff. Default size has 256 locations (each of 8 bytes), but sometimes this ism't enough: im this case, you'll obtain the following essage "Error 2 im file pile.c at lime 58". For instance, in order to (filemane>". mcrease the stack size to 300 locations, invoke ARoff by Faroff -4300 If specified, the -1 option tells ARoff to load the file in memory before processing it. Om am Aniga, this cam make the programne two or three times faster, but of course you'll need to have more free menory. If you fmwoke ARoff without arguments (or with bad arguments), you'll obtain a message telling you about the program version and the right syntax for the arguments. 3. How does it work Like "mroff", ARoff comcatemates automatically the text limes order to obtain a fairly long lime. This is called "filling node", and neams im a text is seem like a words suite that ARoff just copies until it reaches am output lime or umtil you cause a "lime break" (either by a connand or by am empty lime). The following commands will cause a lime break: new page new line centers the following line(s) enables the filling node disables the filling node lime skip indentation temporary indentation User's Reference Manual Page 2 Once a lime has been built, ARoff "adjusts" it according to the node you specified: cemtering, justification, left or right alignenemt. As a result of this you'll have am output lime. The formatting commands (also called "requests") must be given on a separate lime begimming by a period, followed by the request mame (exactly two characters), followed by the optional connand arguments. For using one of the above commands without causing a lime break, specify a instead of a period character (e.g .: "ti -3" in place of ".ti -3"). "quote" 4. List of maim requests In all that follows , positive integer number (for specifying a definite value), or the plus igm followed by a positive integer number (for specifying am increnemt ), or the minus sign followed by a positive integer mumber (for specifying a lecrenemt ). Buffetptione displays the specified message, flushes the output AD just Description: modifies the adjusting mode. If mo Suatax i ad [node] specified, ARoff will re-use the previous value. Here are the values argunewt of node: left justification right justification centering aligmenest Begin Page Description: causes a page break. Next page munber will be N. if am Syntax : bp [N] argument is specified. BReak Description: causes a lime break. Current lime filling is stopped, Syntax br and the lime is printed without adjusting. CEnter Description: cemters the following lime, or the following M limes if Syntax ce [N] you specify am argunewt. EXIt Description: flushes the output buffer and ends. Syntax ex Description: emables the filling node. Syntax Font Style Syntax Description: changes font style. The argument is any combination of: i fs style boldface off boldface on italics off User's Reference Manual Page 3 italic on under lined off under lined om nornal characters Syntax Description: changes the indemtation. If mo argument is specified, ARoff will re-use the previous value. Lime Length Syntax Description: changes the output limes length (included indemtation). If mo argument is specified, ARoff will re-use the previous value. Syntax Description: changes the output limes spacing. Is [[N] specified, ARoff will re-use the previous value. no argument is It Title Length Syntax Description: changes the title length (see "tl" request). : It [[N] argument is specified, ARoff will re-use the previous value. M No Adjusting Syntax put lines adjusting Description: disables the output limes adjusting. NEed Syntax Description: causes a page break if you have less i me [N] before the page ending (1 lime if no tham M limes Before the mext trap. argunewt is specified) or Ho Filling Description: disables the filling node. Syntax lime Numbering Syntax i mn [[mun imt spc idt] Description: emables the lime mumbering. Numbering begins at munber "mun" and will occur every "imt" limes (by default, 1 lime). You'll have "spe" spaces (by default, 1 space) between the numbers and the text, and "idt" spaces (by default, 0 spaces) between the margin and the numbers. Without arguments, munbering is disabled. A non-numeric argument is regarded as a missing one. A missing argument is mot nodi fied. Ho lime Numbering Syntax Description: mo mumbering is made for the following N limes, or the following lime, if mo argument is specified. for Page Length Description: changes the number of limes per page. If mo argument is Syntax PL [EN] specified, ARoff will re-use the default value. Page Hunber Description: changes the next page number. Syntax User's Reference Manual Page 4 Page Offset Description: changes the left margin om all the document (this is Syntax po [[N] different from indemting). If mo argument is specified, ARoff will re-use the previous value. Source Syntax so filemane Description: inserts the content of the file you specified. SPace Description: inserts N empty limes (by default, 1 lime). Syntax i sp [N] ta Tabulation Syntax Description: sets tab marks at columns 1, N+1, 2N+1, etc .. i ta N te Tab Character Syntax Description: tells what character will be used to expand tabs. If mo i te [e] argument is specified, ARoff will re-use the previous value. ti Temporary Indewt Syntax Description: indemts the following lime by the specified value. i tI N Title Syntax Description: prints a text into three parts: "a" will be left tl 'a'b'e' aligmed, "3" will be centered, and "c" right aligned. You can use amy character for separating these three parts; moreover, one or two parts may be empty. Terminal Message Syntax i tm message Description: displays the specified message. tr TRamas late Syntax Description: tells you'll have a comversion om your output: 'a' will i tr abed ... be changed into 'b', 'c' imto 'd', etc .. If you specify am odd number of characters, the last one will be changed into a space. Title Style Syntax stp" is any combination of : Description: speficies title style. "str" is any combination of: i ts str boldface italics under lined Lime format ARoff recognizes the following comstructions: tabulation Mspace> fixed space Mcmeuline> ignored mew-line rest of this lime is a connewt rest of this lime must be read (but mot interpreted) and written om output without amy adjusting: this connand cam be used only in the beginning Imput lime of am Roff User's Reference Manual Page 5 N inserts the value of a register inserts the value of a string t is very strongly recommended mot to have tabs im your text, but rather se the "\t" sequence. Registers allow you to store integer mumeric values. You can handle egisters with the following requests: Syntax mane val time] Description: creates a register "mane" and give to it "ual" as starting value. If you specify am argument "inc", this will be stored as the value of register increnewt. Register mane may be one or two characters long. "ual" and "inc" arguments must be positive integer nunbers. rr Renove Register Syntax i rr mane Description: deletes register "mane". Registers cam be used as follows: inserts the value of register x increments them inserts the value of register x decreneats them inserts the value of register x inserts the value of register xx S+ (xx At-(xx increneats them inserts the value of register xx decrenemts them inserts the value of register xx ARoff presets the following registers: week day (from 1 to 7) nomth day (from 1 to 31) nomth (from 1 to 12) year (two digits) hour (from 0 to 23) mimutes (from 0 to 59) SE current lime number (input) Please take notice that registers giving date and time are initialized when you start ARoff, and will not be updated. Strings allow you to store strings having 255 characters You can handle strings with the following requests: at most. ds Define String i ds mane string Description: creates a string "mane" and affect to it "string" as Syntax value. To keep spaces at the beginning of string, just put quotation mark (") Before the first space. String wane may be one or two characters long. If string "wane" exists, ARoff only changes its Append String Syntax i as mane string Description: adds a given string to the string "wane". If this string doesn't exist, it will be created. To keep spaces at the Begimming of string, just put a quotation mark (") before the first space. User's Reference Manual Page 6 rs Renove String Syntax i rs mane Description: kills string "mane". Strings may be used as follows: inserts the value of string x inserts the value of string xx ARoff defines automatically "fm" string: amd this one takes its value from the current file mane. Macros Macros allow you to store and recall easily a suite of requests and/or a large part of text. You cam handle macros with the following equests: Description: Begins the definition of Description: adds the following limes Cumtil a lime begins by Syntax an mane to a definition of macro "wane". If this macro doesn't exist, It will be created. Renoue Macro i rn mane Description: kills the given macro. Syntax Primt Macro Syntax Description: displays the definition of the given macro. If i pm [mane] argument is specified, ARoff displays the definition of all the nacros. You call a macro exactly im the same way as a request: a period in the egimming of lime, followed by the macro mane. At most, you cam pass mine arguments to a macro. These omes cam be accessed to imto the macro definition by \$1, \$2, .... \99. The count of arguments may be known by looking at the ".Ş" register. Space is the arguments separator. If you have to pass am argument with a space, add a "\" before the space character. If you have to pass an argument with a fixed space, add three pace character. before the CAUTION: Whem ARoff is reading a macro definition, interpreted in the same way as usual. So, remember using text is double "\" before calling up registers, strings or arguncats perforned. if you want to defer their interpretation until the macro is Jalike "mroff", it is forbidden to include a ".de" or "_an" request in your macro definition. It is possible to call a macro within amother one. User's Reference Manual Tage 7 7. Traps Traps allow you to perform a macro at a given vertical position in a page. By this mechanism, you cam add a header or a footer. You can handle traps with the following requests: WHem Syntax i wh lime mane Description: sets a trap at a given lime. The performed macro will be the macro "wane". If there was already a trap at this position, ARoff omly changes the mane of the macro to perform. If "lime" is a negative number, it is a position relative to the end of the page. If "lime" is 0, trap will be performed at the end of the page. rt Renoue Trap Syntax i rt lime Description: remove the trap set at a given lime. CAUTION: Im this version of ARoff, the end of page trap is mever peforned over the last page of a text. When ARoff is just going to write a lime, it looks if a trap is set at this lime. In this case, ARoff calls the specified macro before it tries again to limes. write the lime. This allows to activate a stream of traps set om consecutive B. Conditions ABoff allows macro or request execution, as well as insertion of art of the text, to depend of a condition. You handle conditions with the following requests : If Syntax i if cond anything Description: igmore 'amything' (i.e. the rest of the lime) if the specified condition is not verified. el Else Description: igmore 'amything' (i.e. the rest of the lime) if the Syntax i el anything last condition tested was verified. The "el" request must IMMEDIATLY follow the "if" request. " course, le hisorr roglat vitor the, 1%; character, Cord .if :it! 'Didd page header: ' ntpo' . if '\=(fw'macros' the "macros" file User's Reference Manual Tage 8 el another file .\" Page break if imput lime number > 56 .If \m(il>56 .bp Registers and strings are inserted through a text as it is read. You Cam use either a register or a string as an argument of request. The value of an unknown register is 0: an unknown string is replaced by am enpty one. Am unknown request leads ARoff to look for a macro. The call of am undefined acro will be be ignored. Umlike "mroff", registers, strings and macros are stored in separate lists. This means you may give the same mane to a register, a string and acro: ARoff will make no mistake about them. On the other hand, as the requests list is read before the macro list, if a macro and a request have the sane mane, only the request will be performed. Here is the ARoff error codes list: internal error stack is empty stack is full syntax error 5 table or buffer overflow 6 cammot open the given file 7 incorrect arguments B write error 9 mot sufficient free nenory 10 "el" request without "if" request 11 cammot seck in file read error file to process is empty Here are the default values of ARoff parameters: alignenewt indestation 達 1 tabulation tabulation character space Let ne know remarks and criticism about this program by writing the following address: at M. GOUNELLE Demis Boite 71 6, rue des cailloux 92110 CLICHY - FRANCE